config.risotto Detailed Configuration Guide
Risotto uses a JSON-like configuration file to define your site’s layout, theme, and behavior. Each field customizes how your Markdown files are transformed into a static documentation website.
Example config.risotto
{
"site_name": "Example Documentation",
"site_title": "Example Documentation Site",
"description": "A comprehensive documentation site built with Risotto for example.com.",
"favicon": "https://example.com/images/favicon.png",
"logo": {
"light": "https://example.com/images/logo-light.png",
"dark": "https://example.com/images/logo-dark.png"
},
"theme_icons": {
"light": "https://example.com/images/icon-light.png",
"dark": "https://example.com/images/icon-dark.png"
},
"colors": {
"light": {
"primary": "#2563eb",
"secondary": "#64748b",
"background": "#ffffff",
"text": "#1e293b",
"sidebar": "#f8fafc"
},
"dark": {
"primary": "#3b82f6",
"secondary": "#94a3b8",
"background": "#0f172a",
"text": "#e2e8f0",
"sidebar": "#1e293b"
}
},
"output_dir": "site",
"home_page": "index.md"
}
Field Descriptions
site_name
The short display name of your documentation site. Shown in the sidebar header beside the logo. Default: "Documentation"site_title
The full title used in the HTML title tag of each generated page. Default: "Documentation"description
A short description of your site for SEO and link previews. Used in the HTML meta name="description" tag. Default: "Documentation site built with Risotto"favicon (optional)
URL or local path to the favicon (the small browser tab icon). If omitted, no favicon is included in the generated HTML.logo (optional)
Defines site logos for light and dark themes. Each key (light and dark) can be a URL or local file path. If not set, Risotto uses built-in default SVG logos.theme_icons (optional)
Images for the theme toggle button (light/dark mode switch). Each key (light and dark) can be a URL or base64-encoded SVG. Defaults to Risotto’s built-in sun/moon icons.colors
Defines color palettes for light and dark themes. Each theme supports:- primary — Accent/highlight color
- secondary — Secondary text or accent
- background — Page background
- text — Main text color
- sidebar — Sidebar background